#!/usr/bin/env python2.5
#
# Copyright 2008 the Melange authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Notification (Model) query functions.
"""

__authors__ = [
  '"Lennard de Rijk" <ljvderijk@gmail.com>',
  ]


from soc.cache import sidebar
from soc.logic.helper import notifications
from soc.logic.models import base
from soc.logic.models import user as user_logic

import soc.models.notification


class Logic(base.Logic):
  """Logic methods for the Notification model.
  """

  def __init__(self, model=soc.models.notification.Notification,
               base_model=None, scope_logic=user_logic):
    """Defines the name, key_name and model for this entity.
    """
    super(Logic, self).__init__(model=model, base_model=base_model,
                                scope_logic=scope_logic)

  def _onCreate(self, entity):
    """Sends out a message if there is only one unread notification.
    """

    # TODO(srabbelier): check user preference
    notifications.sendNewNotificationMessage(entity)

    sidebar.flush(entity.scope.account)
    super(Logic, self)._onCreate(entity)

  def _updateField(self, entity, entity_properties, name):
    """If unread changes we flush the sidebar cache.
    """

    value = entity_properties[name]

    if (name == 'unread') and (entity.unread != value):
      # in case that the unread value changes we flush the sidebar.
      sidebar.flush(entity.scope.account)

    return True


logic = Logic()
